Updated docs, exposed middleware.DefaultSkipper

vishr · vishr · commit 52fa135fd557 · 2017-01-28T11:46:43.000-08:00
Signed-off-by: Vishal Rana &lt;vr@labstack.com&gt;
diff --git a/glide.lock b/glide.lock
diff --git a/glide.yaml b/glide.yaml
@@ -2,14 +2,17 @@ package: github.com/labstack/echo
 import:
 - package: github.com/GeertJohan/go.rice
 - package: github.com/dgrijalva/jwt-go
+- package: github.com/facebookgo/grace
+  subpackages:
+  - gracehttp
 - package: github.com/gorilla/websocket
 - package: github.com/labstack/gommon
   subpackages:
   - bytes
   - color
   - log
   - random
-- package: github.com/mattn/go-isatty
+- package: github.com/tylerb/graceful
 - package: github.com/valyala/fasttemplate
 - package: golang.org/x/crypto
   subpackages:
@@ -21,7 +24,6 @@ import:
 - package: gopkg.in/mgo.v2
   subpackages:
   - bson
-- package: github.com/facebookgo/grace
 testImport:
 - package: github.com/stretchr/testify
   subpackages:
diff --git a/middleware/basic_auth.go b/middleware/basic_auth.go
@@ -28,7 +28,7 @@ const (
 var (
 	// DefaultBasicAuthConfig is the default BasicAuth middleware config.
 	DefaultBasicAuthConfig = BasicAuthConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 	}
 )
 
diff --git a/middleware/body_limit.go b/middleware/body_limit.go
@@ -32,7 +32,7 @@ type (
 var (
 	// DefaultBodyLimitConfig is the default Gzip middleware config.
 	DefaultBodyLimitConfig = BodyLimitConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 	}
 )
 
diff --git a/middleware/compress.go b/middleware/compress.go
@@ -36,7 +36,7 @@ const (
 var (
 	// DefaultGzipConfig is the default Gzip middleware config.
 	DefaultGzipConfig = GzipConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 		Level:   -1,
 	}
 )
diff --git a/middleware/cors.go b/middleware/cors.go
@@ -50,7 +50,7 @@ type (
 var (
 	// DefaultCORSConfig is the default CORS middleware config.
 	DefaultCORSConfig = CORSConfig{
-		Skipper:      defaultSkipper,
+		Skipper:      DefaultSkipper,
 		AllowOrigins: []string{"*"},
 		AllowMethods: []string{echo.GET, echo.HEAD, echo.PUT, echo.PATCH, echo.POST, echo.DELETE},
 	}
diff --git a/middleware/csrf.go b/middleware/csrf.go
@@ -67,7 +67,7 @@ type (
 var (
 	// DefaultCSRFConfig is the default CSRF middleware config.
 	DefaultCSRFConfig = CSRFConfig{
-		Skipper:      defaultSkipper,
+		Skipper:      DefaultSkipper,
 		TokenLength:  32,
 		TokenLookup:  "header:" + echo.HeaderXCSRFToken,
 		ContextKey:   "csrf",
diff --git a/middleware/jwt.go b/middleware/jwt.go
@@ -60,7 +60,7 @@ const (
 var (
 	// DefaultJWTConfig is the default JWT auth middleware config.
 	DefaultJWTConfig = JWTConfig{
-		Skipper:       defaultSkipper,
+		Skipper:       DefaultSkipper,
 		SigningMethod: AlgorithmHS256,
 		ContextKey:    "user",
 		TokenLookup:   "header:" + echo.HeaderAuthorization,
diff --git a/middleware/key_auth.go b/middleware/key_auth.go
@@ -40,7 +40,7 @@ type (
 var (
 	// DefaultKeyAuthConfig is the default KeyAuth middleware config.
 	DefaultKeyAuthConfig = KeyAuthConfig{
-		Skipper:    defaultSkipper,
+		Skipper:    DefaultSkipper,
 		KeyLookup:  "header:" + echo.HeaderAuthorization,
 		AuthScheme: "Bearer",
 	}
diff --git a/middleware/logger.go b/middleware/logger.go
@@ -35,7 +35,7 @@ type (
 		// - referer
 		// - user_agent
 		// - status
-		// - latency (In microseconds)
+		// - latency (In nanoseconds)
 		// - latency_human (Human readable)
 		// - bytes_in (Bytes received)
 		// - bytes_out (Bytes sent)
@@ -61,7 +61,7 @@ type (
 var (
 	// DefaultLoggerConfig is the default Logger middleware config.
 	DefaultLoggerConfig = LoggerConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 		Format: `{"time":"${time_rfc3339_nano}","remote_ip":"${remote_ip}","host":"${host}",` +
 			`"method":"${method}","uri":"${uri}","status":${status}, "latency":${latency},` +
 			`"latency_human":"${latency_human}","bytes_in":${bytes_in},` +
@@ -157,8 +157,8 @@ func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc {
 					}
 					return buf.WriteString(s)
 				case "latency":
-					l := stop.Sub(start).Nanoseconds() / int64(time.Microsecond)
-					return buf.WriteString(strconv.FormatInt(l, 10))
+					l := stop.Sub(start)
+					return buf.WriteString(strconv.FormatInt(int64(l), 10))
 				case "latency_human":
 					return buf.WriteString(stop.Sub(start).String())
 				case "bytes_in":
diff --git a/middleware/method_override.go b/middleware/method_override.go
@@ -20,7 +20,7 @@ type (
 var (
 	// DefaultMethodOverrideConfig is the default MethodOverride middleware config.
 	DefaultMethodOverrideConfig = MethodOverrideConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 		Getter:  MethodFromHeader(echo.HeaderXHTTPMethodOverride),
 	}
 )
diff --git a/middleware/middleware.go b/middleware/middleware.go
@@ -8,7 +8,7 @@ type (
 	Skipper func(c echo.Context) bool
 )
 
-// defaultSkipper returns false which processes the middleware.
-func defaultSkipper(c echo.Context) bool {
+// DefaultSkipper returns false which processes the middleware.
+func DefaultSkipper(c echo.Context) bool {
 	return false
 }
diff --git a/middleware/recover.go b/middleware/recover.go
@@ -32,7 +32,7 @@ type (
 var (
 	// DefaultRecoverConfig is the default Recover middleware config.
 	DefaultRecoverConfig = RecoverConfig{
-		Skipper:           defaultSkipper,
+		Skipper:           DefaultSkipper,
 		StackSize:         4 << 10, // 4 KB
 		DisableStackAll:   false,
 		DisablePrintStack: false,
diff --git a/middleware/redirect.go b/middleware/redirect.go
@@ -25,7 +25,7 @@ const (
 var (
 	// DefaultRedirectConfig is the default Redirect middleware config.
 	DefaultRedirectConfig = RedirectConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 		Code:    http.StatusMovedPermanently,
 	}
 )
diff --git a/middleware/secure.go b/middleware/secure.go
@@ -59,7 +59,7 @@ type (
 var (
 	// DefaultSecureConfig is the default Secure middleware config.
 	DefaultSecureConfig = SecureConfig{
-		Skipper:            defaultSkipper,
+		Skipper:            DefaultSkipper,
 		XSSProtection:      "1; mode=block",
 		ContentTypeNosniff: "nosniff",
 		XFrameOptions:      "SAMEORIGIN",
diff --git a/middleware/slash.go b/middleware/slash.go
@@ -19,7 +19,7 @@ type (
 var (
 	// DefaultTrailingSlashConfig is the default TrailingSlash middleware config.
 	DefaultTrailingSlashConfig = TrailingSlashConfig{
-		Skipper: defaultSkipper,
+		Skipper: DefaultSkipper,
 	}
 )
 
diff --git a/website/content/guide/faq.md b/website/content/guide/faq.md
@@ -57,3 +57,24 @@ Q: How to run Echo on a random port?
 ```go
 e.Start(":0")
 ```
+
+Q: How to run Echo on a unix domain socket?
+
+```go
+e := echo.New()
+e.GET("/", func(c echo.Context) error {
+  return c.String(http.StatusOK, "OK")
+})
+os.Remove("/tmp/echo.sock")
+l, err := net.Listen("unix", "/tmp/echo.sock")
+if err != nil {
+  e.Logger.Fatal(err)
+}
+e.Listener = l
+e.Logger.Fatal(e.Start(""))
+```
+
+```sh
+curl --unix-socket /tmp/echo.sock http://localhost
+```
+
diff --git a/website/content/guide/installation.md b/website/content/guide/installation.md
@@ -16,7 +16,7 @@ description = "Installing Echo"
 
 ```sh
 $ cd <project in $GOPATH>
-$ go get -u github.com/labstack/echo
+$ go get -u github.com/labstack/echo/...
 ```
 
 ## Using [glide](http://glide.sh)
diff --git a/website/content/middleware/logger.md b/website/content/middleware/logger.md
@@ -60,7 +60,7 @@ LoggerConfig struct {
   // - referer
   // - user_agent
   // - status
-  // - latency (In microseconds)
+  // - latency (In nanoseconds)
   // - latency_human (Human readable)
   // - bytes_in (Bytes received)
   // - bytes_out (Bytes sent)

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ const (`
`28`	`28`	`var (`
`29`	`29`	`// DefaultBasicAuthConfig is the default BasicAuth middleware config.`
`30`	`30`	`DefaultBasicAuthConfig = BasicAuthConfig{`
`31`		`- Skipper: defaultSkipper,`
	`31`	`+ Skipper: DefaultSkipper,`
`32`	`32`	`}`
`33`	`33`	`)`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ type (`
`32`	`32`	`var (`
`33`	`33`	`// DefaultBodyLimitConfig is the default Gzip middleware config.`
`34`	`34`	`DefaultBodyLimitConfig = BodyLimitConfig{`
`35`		`- Skipper: defaultSkipper,`
	`35`	`+ Skipper: DefaultSkipper,`
`36`	`36`	`}`
`37`	`37`	`)`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ const (`
`36`	`36`	`var (`
`37`	`37`	`// DefaultGzipConfig is the default Gzip middleware config.`
`38`	`38`	`DefaultGzipConfig = GzipConfig{`
`39`		`- Skipper: defaultSkipper,`
	`39`	`+ Skipper: DefaultSkipper,`
`40`	`40`	`Level: -1,`
`41`	`41`	`}`
`42`	`42`	`)`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ type (`
`50`	`50`	`var (`
`51`	`51`	`// DefaultCORSConfig is the default CORS middleware config.`
`52`	`52`	`DefaultCORSConfig = CORSConfig{`
`53`		`- Skipper: defaultSkipper,`
	`53`	`+ Skipper: DefaultSkipper,`
`54`	`54`	`AllowOrigins: []string{"*"},`
`55`	`55`	`AllowMethods: []string{echo.GET, echo.HEAD, echo.PUT, echo.PATCH, echo.POST, echo.DELETE},`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ type (`
`40`	`40`	`var (`
`41`	`41`	`// DefaultKeyAuthConfig is the default KeyAuth middleware config.`
`42`	`42`	`DefaultKeyAuthConfig = KeyAuthConfig{`
`43`		`- Skipper: defaultSkipper,`
	`43`	`+ Skipper: DefaultSkipper,`
`44`	`44`	`KeyLookup: "header:" + echo.HeaderAuthorization,`
`45`	`45`	`AuthScheme: "Bearer",`
`46`	`46`	`}`