From 1e267ab0c79492d900e31935a1521ff1562092be Mon Sep 17 00:00:00 2001 From: Peter Kieltyka Date: Thu, 6 Jul 2017 15:23:11 -0400 Subject: [PATCH] Rename TokenContext method to FromContext --- README.md | 10 +++++----- _example/main.go | 10 +++++----- jwtauth.go | 4 ++-- jwtauth_test.go | 4 ++-- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1f55cea..92dfb6f 100644 --- a/README.md +++ b/README.md @@ -50,14 +50,14 @@ import ( "github.com/go-chi/jwtauth" ) -var TokenAuth *jwtauth.JwtAuth +var tokenAuth *jwtauth.JwtAuth func init() { - TokenAuth = jwtauth.New("HS256", []byte("secret"), nil) + tokenAuth = jwtauth.New("HS256", []byte("secret"), nil) // For debugging/example purposes, we generate and print // a sample jwt token with claims `user_id:123` here: - _, tokenString, _ := TokenAuth.Encode(jwtauth.Claims{"user_id": 123}) + _, tokenString, _ := tokenAuth.Encode(jwtauth.Claims{"user_id": 123}) fmt.Printf("DEBUG: a sample jwt is %s\n\n", tokenString) } @@ -73,7 +73,7 @@ func router() http.Handler { // Protected routes r.Group(func(r chi.Router) { // Seek, verify and validate JWT tokens - r.Use(TokenAuth.Verifier) + r.Use(tokenAuth.Verifier) // Handle valid / invalid tokens. In this example, we use // the provided authenticator middleware, but you can write your @@ -82,7 +82,7 @@ func router() http.Handler { r.Use(jwtauth.Authenticator) r.Get("/admin", func(w http.ResponseWriter, r *http.Request) { - _, claims, _ := jwtauth.TokenContext(r.Context()) + _, claims, _ := jwtauth.FromContext(r.Context()) w.Write([]byte(fmt.Sprintf("protected area. hi %v", claims["user_id"]))) }) }) diff --git a/_example/main.go b/_example/main.go index a81202e..85e5231 100644 --- a/_example/main.go +++ b/_example/main.go @@ -66,14 +66,14 @@ import ( "github.com/go-chi/jwtauth" ) -var TokenAuth *jwtauth.JwtAuth +var tokenAuth *jwtauth.JwtAuth func init() { - TokenAuth = jwtauth.New("HS256", []byte("secret"), nil) + tokenAuth = jwtauth.New("HS256", []byte("secret"), nil) // For debugging/example purposes, we generate and print // a sample jwt token with claims `user_id:123` here: - _, tokenString, _ := TokenAuth.Encode(jwtauth.Claims{"user_id": 123}) + _, tokenString, _ := tokenAuth.Encode(jwtauth.Claims{"user_id": 123}) fmt.Printf("DEBUG: a sample jwt is %s\n\n", tokenString) } @@ -89,7 +89,7 @@ func router() http.Handler { // Protected routes r.Group(func(r chi.Router) { // Seek, verify and validate JWT tokens - r.Use(TokenAuth.Verifier) + r.Use(tokenAuth.Verifier) // Handle valid / invalid tokens. In this example, we use // the provided authenticator middleware, but you can write your @@ -98,7 +98,7 @@ func router() http.Handler { r.Use(jwtauth.Authenticator) r.Get("/admin", func(w http.ResponseWriter, r *http.Request) { - _, claims, _ := jwtauth.TokenContext(r.Context()) + _, claims, _ := jwtauth.FromContext(r.Context()) w.Write([]byte(fmt.Sprintf("protected area. hi %v", claims["user_id"]))) }) }) diff --git a/jwtauth.go b/jwtauth.go index 675e59e..3341120 100644 --- a/jwtauth.go +++ b/jwtauth.go @@ -152,7 +152,7 @@ func (ja *JwtAuth) Verify(paramAliases ...string) func(http.Handler) http.Handle // until you decide to write something similar and customize your client response. func Authenticator(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - token, _, err := TokenContext(r.Context()) + token, _, err := FromContext(r.Context()) if err != nil { http.Error(w, http.StatusText(401), 401) @@ -169,7 +169,7 @@ func Authenticator(next http.Handler) http.Handler { }) } -func TokenContext(ctx context.Context) (*jwt.Token, Claims, error) { +func FromContext(ctx context.Context) (*jwt.Token, Claims, error) { token, _ := ctx.Value(TokenCtxKey).(*jwt.Token) var claims Claims diff --git a/jwtauth_test.go b/jwtauth_test.go index 611b023..feae927 100644 --- a/jwtauth_test.go +++ b/jwtauth_test.go @@ -80,7 +80,7 @@ func TestMore(t *testing.T) { authenticator := func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - token, _, err := jwtauth.TokenContext(r.Context()) + token, _, err := jwtauth.FromContext(r.Context()) if err != nil { switch err { @@ -110,7 +110,7 @@ func TestMore(t *testing.T) { r.Use(authenticator) r.Get("/admin", func(w http.ResponseWriter, r *http.Request) { - _, claims, err := jwtauth.TokenContext(r.Context()) + _, claims, err := jwtauth.FromContext(r.Context()) if err != nil { w.Write([]byte(fmt.Sprintf("error! %v", err)))