diff --git a/README.md b/README.md index ae79cb1..20a5280 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # castle-go -castle-go is a go library wrapping https://castle.io API. +castle-go is a go library wrapping https://castle.io API. ## Install ``` -go get github.com/castle/castle-go/castle +go get github.com/castle/castle-go ``` ## Usage @@ -20,36 +20,36 @@ castle.NewWithHTTPClient("secret-api-key", &http.Client{Timeout: time.Second * 2 ```go castle.Track( - castle.EventLoginSucceeded, - "user-123", - map[string]string{"prop1": "propValue1"}, - map[string]string{"trait1": "traitValue1"}, - castle.ContextFromRequest(req), - ) + castle.EventLoginSucceeded, + "user-123", + map[string]string{"prop1": "propValue1"}, + map[string]string{"trait1": "traitValue1"}, + castle.ContextFromRequest(req), +) ``` ### Tracking custom events ```go castle.Track( - castle.Event("custom-event"), - "user-123", - map[string]string{"prop1": "propValue1"}, - map[string]string{"trait1": "traitValue1"}, - castle.ContextFromRequest(req), - ) + castle.Event("custom-event"), + "user-123", + map[string]string{"prop1": "propValue1"}, + map[string]string{"trait1": "traitValue1"}, + castle.ContextFromRequest(req), +) ``` ### Adaptive authentication ```go decision, err := castle.Authenticate( - castle.EventLoginSucceeded, - "md-1", - map[string]string{"prop1": "propValue1"}, - map[string]string{"trait1": "traitValue1"}, - castle.ContextFromRequest(req), - ) + castle.EventLoginSucceeded, + "md-1", + map[string]string{"prop1": "propValue1"}, + map[string]string{"trait1": "traitValue1"}, + castle.ContextFromRequest(req), +) ``` ### Example diff --git a/castle/castle.go b/castle.go similarity index 100% rename from castle/castle.go rename to castle.go diff --git a/castle/castle_test.go b/castle_test.go similarity index 98% rename from castle/castle_test.go rename to castle_test.go index e3b530e..9ecea82 100644 --- a/castle/castle_test.go +++ b/castle_test.go @@ -6,7 +6,7 @@ import ( "net/http/httptest" "testing" - "github.com/castle/castle-go/castle" + "github.com/castle/castle-go" "github.com/stretchr/testify/assert" ) @@ -201,12 +201,12 @@ func TestContextFromRequest(t *testing.T) { // grabs whitelisted headers only - for _, whitelistedHeader := range castle.HeaderWhitelist { + for _, whitelistedHeader := range castle.HeaderAllowList { req.Header.Set(whitelistedHeader, whitelistedHeader) } ctx = castle.ContextFromRequest(req) - for _, whitelistedHeader := range castle.HeaderWhitelist { + for _, whitelistedHeader := range castle.HeaderAllowList { assert.Contains(t, ctx.Headers, http.CanonicalHeaderKey(whitelistedHeader)) } diff --git a/castle/go.mod b/go.mod similarity index 78% rename from castle/go.mod rename to go.mod index fbe7ad8..d9f75a5 100644 --- a/castle/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/castle/castle-go/castle +module github.com/castle/castle-go go 1.14 diff --git a/castle/go.sum b/go.sum similarity index 100% rename from castle/go.sum rename to go.sum diff --git a/version.go b/version.go new file mode 100644 index 0000000..07f20d6 --- /dev/null +++ b/version.go @@ -0,0 +1,4 @@ +package castle + +// VERSION - current package version +const VERSION = "0.1.0"