-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
James Humphries
committed
Sep 9, 2021
0 parents
commit 0f01b19
Showing
6 changed files
with
190 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # problemdetails | ||
|
|
||
| This is an RFC-7807 compliant library for describing HTTP problems. | ||
|
|
||
| For more information, see [RFC-7807](https://tools.ietf.org/html/rfc7807). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package problemdetails | ||
|
|
||
| type GenericProblem struct { | ||
| Type string `json:"type"` // url to the problem type | ||
| Title string `json:"title"` // problem title | ||
| Status int `json:"status,omitempty"` // http status code | ||
| Detail string `json:"detail,omitempty"` // a human-readable explaination | ||
| Instance string `json:"instance,omitempty"` // A URI reference that identifies the specific ocurrence. Does not need to derefrence to something | ||
| } | ||
|
|
||
| func (problem GenericProblem) WithType(t string) GenericProblem { | ||
| problem.Type = t | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *GenericProblem) WithTitle(title string) *GenericProblem { | ||
| problem.Title = title | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *GenericProblem) WithStatus(status int) *GenericProblem { | ||
| problem.Status = status | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *GenericProblem) WithDetail(detail string) *GenericProblem { | ||
| problem.Detail = detail | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *GenericProblem) WithInstance(instance string) *GenericProblem { | ||
| problem.Instance = instance | ||
| return problem | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| module github.com/vqcomms/problemdetails | ||
|
|
||
| go 1.17 | ||
|
|
||
| require github.com/go-playground/validator/v10 v10.9.0 | ||
|
|
||
| require ( | ||
| github.com/go-playground/locales v0.14.0 // indirect | ||
| github.com/go-playground/universal-translator v0.18.0 // indirect | ||
| github.com/leodido/go-urn v1.2.1 // indirect | ||
| golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 // indirect | ||
| golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 // indirect | ||
| golang.org/x/text v0.3.6 // indirect | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= | ||
| github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= | ||
| github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU= | ||
| github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs= | ||
| github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho= | ||
| github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA= | ||
| github.com/go-playground/validator/v10 v10.9.0 h1:NgTtmN58D0m8+UuxtYmGztBJB7VnPgjj221I1QHci2A= | ||
| github.com/go-playground/validator/v10 v10.9.0/go.mod h1:74x4gJWsvQexRdW8Pn3dXSGrTK4nAUsbPlLADvpJkos= | ||
| github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= | ||
| github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= | ||
| github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= | ||
| github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= | ||
| github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= | ||
| github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= | ||
| github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w= | ||
| github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY= | ||
| github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= | ||
| github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
| github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc= | ||
| github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE= | ||
| github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= | ||
| github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= | ||
| github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= | ||
| golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI= | ||
| golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= | ||
| golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= | ||
| golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
| golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 h1:siQdpVirKtzPhKl3lZWozZraCFObP8S1v6PRp0bLrtU= | ||
| golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= | ||
| golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||
| golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= | ||
| golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||
| golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= | ||
| gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
| gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
| gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= | ||
| gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= | ||
| gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= | ||
| gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package problemdetails | ||
|
|
||
| type Problem interface { | ||
| WithType(t string) *Problem | ||
| WithTitle(title string) *Problem | ||
| WithStatus(status string) *Problem | ||
| WithDetail(detail string) *Problem | ||
| WithInstance(detail string) *Problem | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package problemdetails | ||
|
|
||
| import ( | ||
| "github.com/go-playground/validator/v10" | ||
| ) | ||
|
|
||
| type ValidationError struct { | ||
| Field string | ||
| Error string | ||
| } | ||
|
|
||
| type ValidationProblem struct { | ||
| Type string `json:"type"` // url to the problem type | ||
| Title string `json:"title"` // problem title | ||
| Status int `json:"status,omitempty"` // http status code | ||
| Detail string `json:"detail,omitempty"` // a human-readable explaination | ||
| Instance string `json:"instance,omitempty"` // A URI reference that identifies the specific ocurrence. Does not need to derefrence to something | ||
|
|
||
| // Fields added by VQ | ||
| ValidationErrors []ValidationError `json:"validationerrors,omitempty"` // a list of the validation errors that occurred | ||
| } | ||
|
|
||
| func (problem ValidationProblem) WithType(t string) ValidationProblem { | ||
| problem.Type = t | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) WithTitle(title string) *ValidationProblem { | ||
| problem.Title = title | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) WithStatus(status int) *ValidationProblem { | ||
| problem.Status = status | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) WithDetail(detail string) *ValidationProblem { | ||
| problem.Detail = detail | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) WithInstance(instance string) *ValidationProblem { | ||
| problem.Instance = instance | ||
| return problem | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) ProblemType() string { | ||
| return problem.Type | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) ProblemTitle() string { | ||
| return problem.Title | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) ProblemStatus() int { | ||
| return problem.Status | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) ProblemDetail() string { | ||
| return problem.Detail | ||
| } | ||
|
|
||
| func (problem *ValidationProblem) ProblemInstance() string { | ||
| return problem.Instance | ||
| } | ||
|
|
||
| func FromValidationErrors(validationErrors validator.ValidationErrors) ValidationProblem { | ||
| var errs []ValidationError | ||
|
|
||
| for _, e := range validationErrors { | ||
| errs = append(errs, ValidationError{ | ||
| Field: e.Field(), | ||
| Error: e.Error(), | ||
| }) | ||
| } | ||
|
|
||
| return ValidationProblem{ | ||
| // TODO: Add status code handling here later on, for now about:blank is fine by the RFC | ||
| Type: "about:blank", | ||
| Status: 400, | ||
| Detail: "Invalid request", | ||
| ValidationErrors: errs, | ||
| } | ||
| } |